/**
 * Copyright (c) 2008, Andrew Carter All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer. Redistributions in binary
 * form must reproduce the above copyright notice, this list of conditions and
 * the following disclaimer in the documentation and/or other materials provided
 * with the distribution. Neither the name of Andrew Carter nor the names of
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.acarter.ardor3d.jtree.treenode;

import java.util.ArrayList;
import java.util.List;

import javax.swing.Icon;

import com.acarter.ardor3d.jtree.JTreeIcon;
import com.acarter.composabletree.ComposableTreeNode;
import com.ardor3d.scenegraph.Node;
import com.ardor3d.scenegraph.Spatial;
import com.ardor3d.scenegraph.extension.PassNode;

/**
 * @author Carter
 * 
 */
public class PassNodeTreeNode implements ComposableTreeNode {

	/**
	 * @see com.acarter.composabletree.ComposableTreeNode#getChild(java.lang.Object,
	 *      int)
	 */
	public Object getChild(Object parent, int index) {

		if((parent != null) && (parent instanceof Node)) {

			Node node = (Node) parent;

			// We need to filter out the spatials that are not of type PassNode
			ArrayList<Spatial> filtered = getPassNodeList(node.getChildren());

			return filtered.get(index);
		}
		else
			return null;
	}

	/**
	 * @see com.acarter.composabletree.ComposableTreeNode#getChildCount(java.lang.Object)
	 */
	public int getChildCount(Object parent) {

		if((parent != null) && (parent instanceof Node)) {
			
			List<Spatial> children = ((Node)parent).getChildren();
		
			if(children != null) {
				
				ArrayList<Spatial> filtered = getPassNodeList(children);
				
				return filtered.size();
			}
		}
			
		return 0;
	}

	/**
	 * @see com.acarter.composabletree.ComposableTreeNode#getChildIndex(java.lang.Object,
	 *      java.lang.Object)
	 */
	public int getChildIndex(Object parent, Object child) {

		if((parent != null) && (parent instanceof Node)) {

			if((child != null) && (child instanceof PassNode)) {
			
				// We need to filter out the spatials that are not of type Node
				ArrayList<Spatial> filtered = getPassNodeList(((PassNode)parent).getChildren());
				
				return filtered.indexOf(child);
			}
		}

		return -1;
	}

	/**
	 * @see com.acarter.composabletree.ComposableTreeNode#getParent(java.lang.Object)
	 */
	public Object getParent(Object child) {

		if(child instanceof PassNode)
			return ((PassNode) child).getParent();

		return null;
	}

	/**
	 * @see com.acarter.composabletree.ComposableTreeNode#getNodeClassType()
	 */
	public Class<?> getNodeClassType() {

		return PassNode.class;
	}

	/**
	 * @see com.acarter.composabletree.ComposableTreeNode#getIcon(Object)
	 */
	public Icon getIcon(Object node) {

		if(node instanceof PassNode)
			return JTreeIcon.getIcon().passNode;

		return null;
	}

	/**
	 * @see com.acarter.composabletree.ComposableTreeNode#getNodeText(Object, boolean,
	 *      boolean, boolean, int, boolean)
	 */
	public String getNodeText(Object node, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus) {

		if(node instanceof PassNode)
			return ((PassNode) node).getName();

		return (node != null) ? node.toString() : "";
	}

	/**
	 * @see com.acarter.composabletree.ComposableTreeNode#getNodeToolTipText(Object,
	 *      boolean, boolean, boolean, int, boolean)
	 */
	public String getNodeToolTipText(Object node, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus) {

		return (node != null) ? node.toString() : "";
	}

	/**
	 * Returns a new list containing only Spatials of type Node.
	 * 
	 * @param spatials
	 *            list of spatials
	 * @return list of Nodes
	 */
	private ArrayList<Spatial> getPassNodeList(List<Spatial> spatials) {

		ArrayList<Spatial> filtered = new ArrayList<Spatial>(spatials);

		for(Spatial child : spatials) {

			if(!(child instanceof PassNode))
				filtered.remove(child);
		}

		return filtered;
	}

}
